Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for default language #481

Merged
merged 4 commits into from
Dec 17, 2024

Conversation

chenejac
Copy link
Contributor

@chenejac chenejac commented Dec 9, 2024

VIVO GitHub issue: 4026

  • Other Relevant Links (Mailing list discussion, related pull requests, etc.)

What does this pull request do?

Improve documentation about default language.

What's new?

example.runtime.properties, a comment above languages.selectableLocales property has been updated.

How should this be tested?

Read the text in the comment, and check whether it is easy to understand and aligned with the implementation.

Interested parties

Tag (@ mention) interested parties or, if unsure, @VIVO-project/vivo-committers

Reviewers' expertise

Candidates for reviewing this PR should have some of the following expertises:

  1. Natural language knowledge
    1. English

@chenejac chenejac changed the title Update example.runtime.properties Improve documentation for default language Dec 9, 2024
Copy link
Member

@brianjlowe brianjlowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is maybe a bit longer and more complicated than it needs to be. I would suggest something like the following:

A comma-separated ordered list of locales to be offered to the user in the language-selector dropdown at the top of the VIVO UI. The order of items here controls the order of options in the language selector. The first locale in the list will be used as a default until the user selects another. Each included locale must be supported by VIVO i18n .properties or .ttl files.

Copy link
Member

@hauschke hauschke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@brianjlowe brianjlowe merged commit 23ad9f5 into vivo-project:main Dec 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for default language selection
3 participants